Restructuring of package plus diff generation and new errors #15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In order allow customizations of the golden library per unit test, the goldie library was restructured to not use global variables and adopt the function options pattern: https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis This restructuring also made it easier to implement the following features: * Different fixture directories * A separate directory per unit test * A separate directory per subtest in the unit test * Erroring out if a template didn't get data that it needed * Diff output (classic or in color) * Using your own diff function for output Although a little non standard, the methods that a consumer will be using are now all in the `interface.go` file. In addition, error handling was cleaned up (now uses pointer receivers) and leverages the new Go v1.13 `errors` package. More unit testing is desired.
This description is not needed as it's already defined in goldie.go
This makes the interface.go file more purposeful and also ties similar logic together in goldie.go
This is done to enhance readability.
[refactor] Restructuring of package plus diff generation and new errors
|
@sebdah Thanks for making those updates! It's now been merged into my branch. |
|
Thanks for doing this! I'm just a random person who would probably use this when it lands, so take this with a grain of salt, but a few comments:
|
|
@gtrevg Thank you 👍 |
|
@novas0x2a I think those are good comments, good catch on I'll address the first one in a separate PR that will be merged together with this one when we 🚢 to |
sebdah
approved these changes
Oct 17, 2019
|
@novas0x2a Forgot to comment on the second one; Since we don't have the filename handy right now in that function, I suggest we treat that as a separate feature request. I'll create a ticket for it and we can most likely find a nifty way to address it. I think the request itself makes a lot of sense. 🙇♂️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This version of goldie follows the functional options pattern:
https://dave.cheney.net/2014/10/17/functional-options-for-friendly-apis
It allows for easy, independent configuration of the goldie object, allowing each test case to leverage different options while running in parallel. In addition to the restructuring, a new
DiffEngineoption was added. This allows you to chooseClassicDifforColoredDiffto see the difference in the golden files, or you could even use theDiffFnoption to implement your own diff function.Errors were also updated to use pointer receivers instead of value receivers. This is the pattern that Go uses internally. In addition, the new
errorspackage from Go v1.13 was incorporated. This will require those using this package to compile with Go v1.13 or higher.This PR will close out #8 and #10 .